山寨一个 Boost.Bind
2012-04-21 15:01:00
一直比较好奇 boost::bind 里面占位符和参数的顺序是怎么实现的，也一直看不太懂这方面源代码，昨晚好好看了下，终于有点弄懂了。小记一笔，与大家分享。
先看一个简单的用例：
1#include <boost/bind.hpp>
2
3int foo(bool a, int b, double c)
4{
5 return 0;
6}
7
8int main()
9{
10 boost::bind(foo, _2, 2, _1)(3.0, true); // foo(true, 2, 3.0)
11
12 return 0;
13}
这里有两个步骤，第一步是绑定过程，第二步是调用。
绑定过程给出了 boost::bind 所需要的几乎所有信息——只有两个参数——_1 和 _2——的类型和值，有待确定。但是他们的顺序是确定了的，类型实际上也由函数签名所限制。bind 是一个函数，返回一个 bind_t 类型的对象，bind_t 是一个仿函数。
三个参数时 bind_t 应具备的参数信息：
| 参数1 | 参数2 | 参数3 |
|---|---|---|
| 占位符2 | 绑定值 | 占位符1 |
调用的时候给出的参数表只有两个：
| 参数1 | 参数2 |
|---|---|
| 值1 | 值2 |
调用时的参数匹配过程如下：
我们暂且把第二列中的参数表称为 BindList，第三列的参数表称为 CallList。BindList 和 CallList 都需要保存参数，这部分公用的东西先简单实现如下：
1struct BindArguments0
2{
3
4};
5
6template <typename A1>
7struct BindArguments1 : public BindArguments0
8{
9 BindArguments1(A1 a1) : a1(a1)
10 {
11
12 }
13
14 A1 a1;
15};
16
17template <typename A1, typename A2>
18struct BindArguments2 : public BindArguments1<A1>
19
20 BindArguments2(A1 a1, A2 a2) : BindArguments1(a1), a2(a2)
21 {
22
23 }
24
25 A2 a2;
26};
27
28template <typename A1, typename A2, typename A3>
29struct BindArguments3 : public BindArguments2<A1, A2>
30{
31 BindArguments3(A1 a1, A2 a2, A3 a3) : BindArguments2(a1, a2), a3(a3)
32 {
33
34 }
35
36 A3 a3;
37};
为了简洁和突出关键，我们暂时只实现到 3 个参数。从上面的代码看，多一个参数，代码是线性增长的，不是指数级增长的，所以很容易（人工地）扩充到所需要的参数个数。如果需要玩些花样，可以使用宏循环技巧自动生成代码，这部分东西在《C++ 下 Function 对象的实现（下）》中已经谈到过，本文不再赘述。
接下来实现 CallList0 到 CallList3，它除了存储参数，还具备用占位符查询出实际值的能力。占位符实现如下：
1static struct PlaceHolder1
2{
3
4} _1;
5
6static struct PlaceHolder2
7{
8
9} _2;
10
11static struct PlaceHolder3
12{
13
14} _3;
对，就这么简单粗暴就可以了。网上有些文章说使用 int to type，那也可以，做成这样：
1template <int i>
2struct PlaceHolder
3{
4
5};
6
7static PlaceHolder<1> _1;
8static PlaceHolder<2> _2;
9static PlaceHolder<3> _3;
但关键点不在这里。我们只要能对各种占位符区分类型就可以了。下文以第一个简单的定义为准。 CallList 这样子定义（灰色的先假装没看见）：
1class CallList0 : public BindArguments0
2{
3public:
4 CallList0()
5 {
6
7 }
8
9public:
10 template <typename T>
11 T operator [](T t)
12 {
13 return t;
14 }
15};
16
17template <typename A1>
18class CallList1 : public BindArguments1<A1>
19{
20public:
21 CallList1(A1 a1) : BindArguments1<A1>(a1)
22 {
23
24 }
25
26public:
27 A1 operator [](PlaceHolder1)
28 {
29 return a1;
30 }
31
32 template <typename T>
33 T operator [](T t)
34 {
35 return t;
36 }
37};
38
39template <typename A1, typename A2>
40class CallList2 : public BindArguments2<A1, A2>
41{
42public:
43 CallList2(A1 a1, A2 a2) : BindArguments2<A1, A2>(a1, a2)
44 {
45
46 }
47
48public:
49 A1 operator [](PlaceHolder1)
50 {
51 return a1;
52 }
53
54 A2 operator [](PlaceHolder2)
55 {
56 return a2;
57 }
58
59 template <typename T>
60 T operator [](T t)
61 {
62 return t;
63 }
64};
65
66template <typename A1, typename A2, typename A3>
67class CallList3: public BindArguments3<A1, A2, A3>
68{
69public:
70 CallList3(A1 a1, A2 a2, A3 a3) : BindArguments3(a1, a2, a3)
71 {
72
73 }
74
75public:
76 A1 operator [](PlaceHolder1)
77 {
78 return a1;
79 }
80
81 A2 operator [](PlaceHolder2)
82 {
83 return a2;
84 }
85
86 A3 operator [](PlaceHolder3)
87 {
88 return a3;
89 }
90
91 template <typename T>
92 T operator [](T t)
93 {
94 return t;
95 }
96};
存储已经由 BindArguments 负责了，CallList 实现了 operator[] 用于从 PlaceHolderN 查询调用时的参数 aN。
还有一个问题，CallList 中的参数个数往往会比 BindList 中的少（其中某几个已经用实际值绑定了），这样，从 BindList 到 CallList 查询的时候，需要判断哪些是 PlaceHolder，哪些是实际参数，这就不太好操作了。为了到时候统一写法，我们让 CallList 不仅支持使用 PlaceHolder 查询，也支持使用实际参数值来查询。增加上面灰色代码，使用实际参数查询的时候，直接返回那个值。
CallList 就到此为止。现在开始实现 BindList。跟 CallList 一样，每个 BindList 都继承 BindArguments。……似乎这样就完事了？BindList 貌似没其他事情好做了。。。不过，BindList 里面保存了最原始的参数个数信息，如果我们不对函数进行萃取的话，参数个数只能从这里获取，因此调用过程只能写在这里——貌似还没说清楚，不要紧，这是后话。暂且把相关代码变灰，等下就可以看到原委了。
1class BindList0 : public BindArguments0
2{
3public:
4 BindList0()
5 {
6
7 }
8
9public:
10 template <typename F, typename A>
11 void operator ()(F f, A a)
12 {
13 f();
14 }
15};
16
17template <typename A1>
18class BindList1 : public BindArguments1<A1>
19{
20public:
21 BindList1(A1 a1) : BindArguments1<A1>(a1)
22 {
23
24 }
25
26public:
27 template <typename F, typename A>
28 void operator ()(F f, A a)
29 {
30 f(a[a1]);
31 }
32};
33
34template <typename A1, typename A2>
35class BindList2 : public BindArguments2<A1, A2>
36{
37public:
38 BindList2(A1 a1, A2 a2) : BindArguments2<A1, A2>(a1, a2)
39 {
40
41 }
42
43public:
44 template <typename F, typename A>
45 void operator ()(F f, A a)
46 {
47 f(a[a1], a[a2]);
48 }
49};
50
51template <typename A1, typename A2, typename A3>
52class BindList3: public BindArguments3<A1, A2, A3>
53{
54public:
55 BindList3(A1 a1, A2 a2, A3 a3) : BindArguments3(a1, a2, a3)
56 {
57
58 }
59
60public:
61 template <typename F, typename A>
62 void operator ()(F f, A a)
63 {
64 f(a[a1], a[a2], a[a3]);
65 }
66};
快到最后一步了。我们现在可以来考虑 Bind 的最终形式了——模版类？模板函数？从使用上来说，模版类在用的时候必须给出模版参数，想象一下这样的写法：
1bind<int (bool, int, double), PlaceHolder2, int, PlaceHolder1>(foo, _2, 2, _1)）
……太没有易用性了。而模版函数则不用事先给出模版参数。boost::bind 也实现成了一组模板函数。同时，函数 Bind 返回的东西必须是可执行体，而且要包含一个BindList，C++ 里面只有仿函数能做到。这个结构我们定义为 BindT。先看代码：
1template <typename F, typename BL>
2class BindT
3{
4public:
5 BindT(F f, BL bl) : f(f), bl(bl)
6 {
7
8 }
9
10public:
11 void operator ()()
12 {
13 bl(f, CallList0());
14 }
15
16 template <typename A1>
17 void operator ()(A1 a1)
18 {
19 bl(f, CallList1<A1>(a1));
20 }
21
22 template <typename A1, typename A2>
23 void operator ()(A1 a1, A2 a2)
24 {
25 bl(f, CallList2<A1, A2>(a1, a2));
26 }
27
28 template <typename A1, typename A2, typename A3>
29 void operator ()(A1 a1, A2 a2, A3 a3)
30 {
31 bl(f, CallList3<A1, A2, A3>(a1, a2, a3));
32 }
33
34private:
35 F f;
36 BL bl;
37};
BindT 保存了函数 f 以及 BindList bl。我们找一个 operator()(A1 a1) 来看，里面写成了 bl(f, CallList1(a1));，这得益于 BindList 里面实现了 operator()()。
按通常理解，可能会写成这样：
1CallList1<A1> cl(a1);
f(cl[bl.a1], cl[bl.a2], ……) 等等，bl 里面到底有几个元素？这就不知道了，因为 BindT 接受的只是一个 BindList，所以需要 BindList 给出执行形式。因此，上面 BindList 需要灰色部分的 operator()() 代码。（当然，也可以换种实现方法，抛弃 BindList，在 BindT 中将参数散开来，这看上去也是可行的。）
最后，给出一组 Bind 模版函数，作为最终使用接口：
1template <typename F>
2BindT<F, BindList0> Bind(F f)
3{
4 return BindT<F, BindList0>(f, BindList0());
5}
6
7template <typename F, typename T1>
8BindT<F, BindList1<T1>> Bind(F f, T1 t1)
9{
10 return BindT<F, BindList1<T1>>(f, BindList1<T1>(t1));
11}
12
13template <typename F, typename T1, typename T2>
14BindT<F, BindList2<T1, T2>> Bind(F f, T1 t1, T2 t2)
15{
16 return BindT<F, BindList2<T1, T2>>(f, BindList2<T1, T2>(t1, t2));
17}
18
19template <typename F, typename T1, typename T2, typename T3>
20BindT<F, BindList3<T1, T2, T3>> Bind(F f, T1 t1, T2 t2, T3 t3)
21{
22 return BindT<F, BindList3<T1, T2, T3>>(f, BindList3<T1, T2, T3>(t1, t2, t3));
23}
好了，简单实现到此为止。我们这里只是注重了参数表如何存储，如何使用占位符更改顺序，对于其他问题则没有做过多考虑。还有诸如 const/非const、有返回值/无返回值，引用/非引用、函数指针/成员函数/仿函数等问题都没有涉及。以上代码仅仅支持普通函数，不支持成员函数和仿函数。
做个简单的测试：
1int foo0()
2{
3 return 0;
4}
5
6int foo1(int a)
7{
8 return 0;
9}
10
11int foo2(int a, int b)
12{
13 return 0;
14}
15
16int foo3(int a, int b, int c)
17{
18 return 0;
19}
20
21int main()
22{
23 Bind(foo0)();
24 Bind(foo1, _1)(1);
25 Bind(foo1, 2)();
26 Bind(foo2, _1, _2)(1, 2);
27 Bind(foo2, _2, _1)(1, 2);
28 Bind(foo2, _1, 1)(2);
29 Bind(foo2, 1, _1)(2);
30 Bind(foo2, 1, 2)();
31 Bind(foo3, _1, _2, _3)(1, 2, 3);
32 Bind(foo3, _1, _3, _2)(1, 2, 3);
33 Bind(foo3, _2, _1, _3)(1, 2, 3);
34 Bind(foo3, _2, _3, _1)(1, 2, 3);
35 Bind(foo3, _3, _1, _2)(1, 2, 3);
36 Bind(foo3, _3, _2, _1)(1, 2, 3);
37 Bind(foo3, _1, _2, 3)(1, 2);
38 Bind(foo3, _2, _1, 3)(1, 2);
39 Bind(foo3, _1, 2, 3)(1);
40
41 return 0;
42}
将以上代码合起来（去除开头第一段代码和中间一个 PlaceHolder的代码），就是可运行的程序了。（VS2010通过）
示例程序中的各个结构与 boost::bind 实际代码的对应关系如下：
| 示例代码 | boost |
|---|---|
| Bind | bind |
| BindT | _bi::bind_t |
| BindListN | listN |
| CallListN | listN |
| BindArgumentsN | storageN |
| PlaceHolderN | arg |
BindList 和 CallList 在 boost::bind 的实现中是合并的，这是阅读时的很大干扰源。所以刚才把他们拆了讲，但愿能写明白些。 |
好久没发了，请各位指教。
首发：http://www.cppblog.com/Streamlet/archive/2012/04/21/172241.html